LotusScript Doc

Class: LSAGlossaryReferenceS

Maintaines a list of Glossary references.

Version:
1.2.2, 08.JUN.2000
History:
08.JUN.2000RGRDelete method changed



Property Summary
Public Property Set BlockUpdate As Variant
Public Property Set DisplayColumn As Integer
Public Property Get DisplayColumn As Integer
Public Property Set ManagerID As String
Public Property Get ManagerID As String
Public Property Get ManagerInstance As Variant
Public Property Set Prefix As String

Method Summary
Sub AddItem (NewItem As Variant)
Sub ClearAllItems ()
Sub ClearCurrentItem ()
Sub Delete ()
Function ExternalRepresentation (Reference As String, DisplayColumn As Integer, PrefixLevel As Integer) As String
Sub fillFromDoc (doc As NotesDocument)
Function GetCurrentItem () As Variant
Function GetFirstItem () As Variant
Function GetNextItem () As Variant
Function GetPreviousItem () As Variant
Sub New (ManagerID As String)
Function saveToPredefinedFields (doc As NotesDocument) As Integer
Sub SetCurrentItem (NewCurrentItem As Variant)
Sub UpdateCurrentItem (UpdateItem As Variant)
Function UpdateThisReference (Reference As String, Keyword As String, Prefix As String, DisplayColumn As Integer) As Integer

Property Detail

Public Property Set ManagerID AsString

Sets ID of the manager class object. This class has to provide the access to the functions of the corresponding glosssary db.

Summmary Top

Public Property Get ManagerID AsString

Summmary Top

Public Property Get ManagerInstance AsVariant

Returns the manager class object. This class has to provide the access to the functions of the corresponding glosssary db.

Summmary Top

Public Property Set BlockUpdate AsVariant

Sets the attribute that prevents the keywords from being updated

Parameters:
BlockUpdateVarianta non blank string or the boolean true sets the attribute everything other resets it
Summmary Top

Public Property Set DisplayColumn AsInteger

Sets the attribute that prevents the keywords from being updated

Parameters:
BlockUpdateVarianta non blank string or the boolean true sets the attribute everything other resets it
Summmary Top

Public Property Get DisplayColumn AsInteger

Summmary Top

Public Property Set Prefix AsString

Sets the attribute that prevents the keywords from being updated

Parameters:
BlockUpdateVarianta non blank string or the boolean true sets the attribute everything other resets it
Summmary Top
Method Detail

New

Public Sub New(ManagerID As String)
Initializes the list.

Summmary Top

Delete

Public Sub Delete
Default destructor of the class. Deletes all child objects

History:
08.JUN.2000RGRDelete the children
Summmary Top

AddItem

Public Sub AddItem(NewItem As Variant)
Adds a new Keyword Item to the list, The keyword item is a pair consistion of the internal Reference and the display version of it like |~|elem2-1~elem2-2~...|elem3-1~elem3-2~... and elem2-1/elem3-1... where the element displayed depends on the Tuple column and the prefix. Each one of the array elements may be "" but not both!

Parameters:
newItemVarianta two dimensional array
Summmary Top

ClearCurrentItem

Public Sub ClearCurrentItem
Deletes the current item from the list

Summmary Top

ClearAllItems

Public Sub ClearAllItems
Reinitializes the phone list

Summmary Top

UpdateCurrentItem

Public Sub UpdateCurrentItem(UpdateItem As Variant)
Updates the current item with the data from the UpdateItem

Parameters:
UpdateItemVarianta two dimensional array
See also:
#addItem
Summmary Top

SetCurrentItem

Public Sub SetCurrentItem(NewCurrentItem As Variant)
Set the current item to the parameter item

Summmary Top

GetCurrentItem

Public Function GetCurrentItem As Variant
Returns the current item of the list

Returns:
Varianta two dimensional array
Summmary Top

GetFirstItem

Public Function GetFirstItem As Variant
Returns the first item of the list

Returns:
Varianta two dimensional array
Summmary Top

GetNextItem

Public Function GetNextItem As Variant
Returns the item next to the current item of the list If the last item is reached the next will be return empty!

Returns:
Varianta two dimensional array
Summmary Top

GetPreviousItem

Public Function GetPreviousItem As Variant
Summmary Top

saveToPredefinedFields

Public Function saveToPredefinedFields(doc As NotesDocument) As Integer
Stores attribute values for the convinience of the programmer. The fields of documents relate to the subform LSASubPhone from LSL-Address The attribute are only stored if they differ from the values on disk.

Parameters:
docNotesDocumentthe document in which the attributes are stored
Returns:
Booleantrue, if an document item has been changed
Summmary Top

UpdateThisReference

Public Function UpdateThisReference(Reference As String,Keyword As String,Prefix As String,DisplayColumn As Integer) As Integer
It requires >the reference to be synchronized with, the format or the reference is like |~|em2-1~elem2-2~...|lem3-1~elem3-2~..... >the Keyword that may be used to resynchronize >the prefix that has to be ignored for the external representation usually word 0 and word 1 (delimiters) can be ignored but you may choose a path to a subtree also >the display column in the item from which the external name is created, remember, the item in each level is an tuple like elem1~elem2~... and returns a true if an update is required. In this case reference and keyword contain the new values!

Summmary Top

ExternalRepresentation

Public Function ExternalRepresentation(Reference As String,DisplayColumn As Integer,PrefixLevel As Integer) As String
It requires the > reference from which the external representation is created, format or the reference is like |~|elem2-1~elem2-2~...|elem3-1~elem3-2~... > display column in the item from which the external name is created, remember, the item in each level is an tuple like elem1~elem2~... but we can have only one value for display usually it is 2 >prefixLevel is the index of the llast element to be ignored for the external representation usually it is1 asword 0 and word 1 (delimiters) can be ignored in a serialized format and returns a true if an update is required. In this case reference and keyword contain the new values!

Summmary Top

fillFromDoc

Public Sub fillFromDoc(doc As NotesDocument)
Fills the attributes of the current object by reading a set from predefined fields from the document which is passed in as parameter.

Parameters:
docNotesDocumentthe document which is used to fill the object
Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:45:33 AM